Day 18. Hugo Site 自動部署 - 使用 Bash Shell Script

12th鐵人賽 hugo

littlebookboy

2020-10-01 07:57:53

2391 瀏覽

分享至

官方腳本

以下是官方提供部署到 GitHub 的腳本 (出處)，筆者在此翻譯一下註解：

#!/bin/sh

# 若腳本任一行執行命令發生錯誤，導致 fail，則腳本停止往下執行
set -e

# 輸出提示文字：Deploying updates to GitHub...
printf "\033[0;32mDeploying updates to GitHub...\033[0m\n"

# 下 hugo 打包 public 資料夾
# 你可以變更此指令，帶入任何想追加的參數，例如指定佈景：`hugo -t <YOURTHEME>`
hugo 

# 進 public
cd public

# 把剛剛 `hugo` 渲染的結果，新增到 Changes to be committed 區，準備提交
git add .

# Commit 這次的異動
msg="rebuilding site $(date)"
if [ -n "$*" ]; then
	msg="$*"
fi
git commit -m "$msg"

# Push source and build repos.
git push origin master

補充說明一下，可以看出腳本中的 msg 是每次 git commit 會填入的訊息，該 commit msg 會長成這樣

請注意，若你需要標注每次執行 git push 的是誰，你必須先在本地設置 git config --global user.name 與 user.email：

$ git config --global user.name "YourName"
$ git config --global user.email your-name@example.com

自訂腳本 deploy.sh

筆者以原腳本為基礎做了些異動，原因如下：

曾經發布過的舊文章、舊網址，不會因為你砍了檔案，就從版本控制中消失，你必須完整覆蓋掉他們，否則那些文章、頁面依然會存在。
筆者追加了其它腳本，為的是將整個 hugo site 專案，一併執行提交本次異動，到另一個資源庫。

#!/bin/sh

##############################################
# 確認本地靜態資源包是否存在，是的話就移除
##############################################
set -e
# 移除上次可能留下的 original public repository
if [ -d "origin-public-repo" ]; then
  rm -rf origin-public-repo
fi
# 移除上次可能留下的 hugo 產生的 new public
if [ -d "public" ]; then
  rm -rf public
fi

##############################################
# Clone public origin project
##############################################
git clone
# 更名 littlebookboy.github.io 為 origin-public-repo
git@github.com:littlebookboy/littlebookboy.github.io.git origin-public-repo

##############################################
# Run `hugo` to Re-Build the project.
##############################################
hugo -t "tranquilpeak"

##############################################
# hugo 打包不會產生的檔案，但需被一同提交（保留的檔案）
##############################################
#   - .git
#   - CNAME
#   - README.md
cp -R ./origin-public-repo/.git ./public
cp ./origin-public-repo/CNAME ./public
cp ./origin-public-repo/README.md ./public
cd public

##############################################
# Add changes to git.
##############################################
git add .

##############################################
# Commit changes. (保留原腳本做法)
##############################################
msg="rebuilding site $(date)"
if [ -n "$*" ]; then
	msg="$*"
fi
git commit -s -m "$msg"

##############################################
# Push the /public source and build repos.
##############################################
# 使用 --force，just in case，
# 請確定你知道自己在幹嘛在移除註解，套用 force push
git push origin master # --force

##############################################
# 備份: 一併執行提交本次 ./myblog 異動到另一個資源庫
##############################################
cd ..
git add .
git commit -m "update blog"
git push origin master